cs-invoice-processing-sapi
o6a-urj/📚 Data Dictionary - CS Utilities System API Service
This section describes the attributes and usage of the Invoice Processing API Service.
💂️ Base Information
- API Title: Invoice Processing API Service
- Version: v1
- Base URL:
https://cs-invoice-processing-sapi-{env}-v1.us-e1.cloudhub.io/api/Replace{env}with:dev(Development)qa(Quality Assurance)
🔑 Authentication
Required Headers
| Header | Type | Description |
|---|---|---|
| Authorization | String | Bearer token in the format Bearer {{API_KEY}} |
| client_id | String | Unique identifier for API clients |
- Authorization
- Length: 36 - 37 characters
- Example:
Bearer abcdefghijklmnopqrstuvwxyz1234567890
- client_id
- Length: 32 - 36 characters
- Example:
123e4567-e89b-12d3-a456-426614174000
📌 These headers are required in all requests.
📂 Endpoints
📄 GET /documents/pending
Returns the unique identifiers of the documents that are pending sending to the ERP.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| customerTaxID | String | ✅ | Tax ID of the receiving company |
| documentTypeCode | String | ❌ | Type of document to retrieve |
Response
Returns a list of document identifiers.
📁 Example: examples/responses/get-pendingDocuments.json
📄 GET /documents/returnDocuments
Returns an invoice’s data structure in XML format.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| customerTaxID | String | ❌ | Receiving company ID |
| idInvoice | Number | ❌ | Invoice identifier |
| filingNumber | String | ❌ | Document filing number |
Response
Returns a document's full structure.
📁 Example: examples/responses/get-documents.json
📄 GET /documents/attachments
Returns the files provided by the supplier for processing the invoice.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| customerTaxID | String | ❌ | Receiving company ID |
| idInvoice | Number | ❌ | Invoice identifier |
| filingNumber | String | ❌ | Document filing number |
Response
📁 Example: examples/responses/get-attachments.json
📄 POST /documents/processed
Marks the document as processed by the ERP.
Request Body
📁 Example: examples/requests/post-processed.json
📄 Type: lib-types.post-processed
Response
📁 Example: examples/responses/post-processed.json
📄 Type: lib-types.post-processed-response
📄 POST /documents/status
Updates the status of an invoice after delivery to the ERP.
Request / Response
📁 Request: examples/requests/post-status.json
📁 Response: examples/responses/post-status.json
📄 Type: lib-types.post-status
📄 POST /documents/suppliers
Creates suppliers in Invoway.
Request / Response
📁 Request: examples/requests/post-suppliers.json
📁 Response: examples/responses/post-suppliers.json
📄 Type: lib-types.post-suppliers
📄 POST /suppliers/externalUser
Creates a user for a supplier using external authentication.
Request / Response
📁 Request: examples/requests/post-suppliers-externalUser.json
📁 Response: examples/responses/post-suppliers-externalUser.json
📄 GET /digital-wallets/send-payments-orders
Sends payment orders.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| markToSend | Integer | ✅ | Indicates documents to be sent |
📁 Response: examples/responses/get-send-payments-orders.json
📄 Type: lib-types.get-send-payments-orders-response
📄 POST /digital-wallets/receive-payments-orders
Receives the result of processed payment orders from digital wallets.
📁 Request: examples/requests/post-receive-payments-orders.json
📁 Response: examples/responses/post-receive-payments-orders.json
📄 Type: lib-types.post-receive-payments-orders
📊 Common Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
client_id | String | API client identifier | ✅ |
Authorization | String | Bearer token for authentication | ✅ |
🔐 Security Schemes
Client ID Enforcement
| Field | Type | Required | Length | Regex |
|---|---|---|---|---|
client_id | String | Yes | 32 - 36 | [a-zA-Z0-9] |
client_secret | String | Yes | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
| Field | Type | Required | Length | Regex |
|---|---|---|---|---|
Authorization | String | Yes | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Error Codes
| Code | Description | Suggested Solution |
|---|---|---|
| 400 | Bad Request | Check request syntax and parameters. |
| 401 | Unauthorized | Validate authentication credentials. |
| 404 | Not Found | Confirm the endpoint URL. |
| 500 | Internal Server Error | Retry or contact technical support. |
⚠️ Error Codes
| Code | Description | Suggested Solution |
|---|---|---|
| 400 | Bad Request | Check request syntax and parameters. |
| 401 | Unauthorized | Validate authentication credentials. |
| 404 | Not Found | Confirm the endpoint URL. |
| 500 | Internal Server Error | Retry or contact technical support. |
📞 Support
For assistance, contact the Integration Services and Applications Coordination team.
Email: epalma@fg
Last updated: April 2025